<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <script>
    var gaProperty = 'UA-2577926-1';
    // Disable tracking if the opt-out cookie exists.
    var disableStr = 'ga-disable-' + gaProperty;
    if (document.cookie.indexOf(disableStr + '=true') > -1) {
      window[disableStr] = true;
    }
    function gaOptout() {
      document.cookie = disableStr + '=true; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
      window[disableStr] = true;
    }
    function gaOptoutRevoke() {
      document.cookie = disableStr + '=false; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/';
      window[disableStr] = false;
    }
    </script>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-2577926-1"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-2577926-1', { 'anonymize_ip': true });
    </script>
    <link type="text/css" rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css" />
    <script src="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js"></script>
    <script>
    window.addEventListener("load", function() {
      window.cookieconsent.initialise({
        'palette': {
          'popup': {
            'background': '#eaf7f7',
            'text': '#5c7291'
          },
          'button': {
            'background': '#56cbdb',
            'text': '#ffffff'
          }
        },
        'theme': 'edgeless',
        'type': 'opt-out',
        'onInitialise': function (status) {
          if (!this.hasConsented()) {
            gaOptout()
          }
        },
        'onStatusChange': function(status, chosenBefore) {
          if (!this.hasConsented()) {
            gaOptout()
          }
        },
        'onRevokeChoice': function() {
          gaOptoutRevoke()
        }
      })
    });
    </script>
    <title>OpenLayers v6.13.0 API - Class: Map</title>
    <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=fetch"></script>
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="scripts/jquery.min.js"></script>
    <script src="scripts/bootstrap.bundle.min.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
    <link type="text/css" rel="stylesheet" href="styles/site.css">
  </head>
  <body>
    <div class="container-fluid">
      <header class="navbar navbar-expand-sm navbar-dark mb-3 py-0 fixed-top" role="navigation">
        <a class="navbar-brand" href="https://openlayers.org/"><img src="logo-70x70.png" alt="">&nbsp;OpenLayers</a>

        <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#olmenu" aria-controls="olmenu" aria-expanded="false" aria-label="Toggle navigation">
          <span class="navbar-toggler-icon"></span>
        </button>

        <!-- menu items that get hidden below 768px width -->
        <nav class="collapse navbar-collapse" id="olmenu">
          <ul class="navbar-nav ml-auto">
          <li class="nav-item dropdown">
            <a class="nav-link dropdown-toggle" href="#" id="docdropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Docs</a>
            <div class="dropdown-menu dropdown-menu-right" aria-labelledby="docdropdown">
              <a class="dropdown-item" href="/en/latest/doc/">Docs</a>
              <div class="dropdown-divider"></div>
                <a class="dropdown-item" href="../doc/quickstart.html"><i class="fa fa-check fa-fw mr-2 fa-lg"></i>Quick Start</a>
                <a class="dropdown-item" href="../doc/faq.html"><i class="fa fa-question fa-fw mr-2 fa-lg"></i>FAQ</a>
                <a class="dropdown-item" href="../doc/tutorials/"><i class="fa fa-book fa-fw mr-2 fa-lg"></i>Tutorials</a>
                <a class="dropdown-item" href="/workshop/"><i class="fa fa-graduation-cap fa-fw mr-2 fa-lg"></i>Workshop</a>
                <div class="dropdown-divider"></div>
                <a class="dropdown-item" href="https://stackoverflow.com/questions/tagged/openlayers"><i class="fa fa-stack-overflow fa-fw mr-2"></i>Ask a Question</a>
            </div>
          </li>
          <li class="nav-item"><a class="nav-link" href="../examples/">Examples</a></li>
          <li class="nav-item active"><a class="nav-link" href="../apidoc/"><i class="fa fa-sitemap mr-1"></i>API</a></li>
          <li class="nav-item dropdown">
            <a class="nav-link dropdown-toggle" href="#" id="codedropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Code</a>
            <div class="dropdown-menu dropdown-menu-right" aria-labelledby="codedropdown">
              <a class="dropdown-item" href="https://github.com/openlayers/openlayers"><i class="fa fa-github fa-fw mr-2 fa-lg"></i>Repository</a>
              <a class="dropdown-item" href="/download/"><i class="fa fa-download fa-fw mr-2 fa-lg"></i>Download</a>
            </div>
           </li>
          </ul>
        </nav>
      </header>
      <div id="wrap" class="row">
        <div class="navigation col-md-4 col-lg-3">
          <div class="search-wrapper">
            <div class="search">
              <input id="search" type="text" autocomplete="off" class="form-control input-sm" placeholder="Search Documentation">
            </div>
          </div>
          <div class="navigation-list-wrapper">
            <ul class="navigation-list search-empty">
<li class="item item-class toggle-manual toggle-manual-show" data-longname="module:ol/Map~Map" data-name="ol/map">
    <span class="title toggle">
        <span class="fa fa-chevron-right mr-2 mt-1"></span>
        <span><a href="module-ol_Map-Map.html">ol​/Map</a></span>
    </span>
    <div class="member-list" data-type="methods">
        <span class="subtitle">Methods</span>
        <ul>
            <li data-name="addcontrol"><a href="module-ol_Map-Map.html#addControl">addControl</a>
            <li data-name="addinteraction"><a href="module-ol_Map-Map.html#addInteraction">addInteraction</a>
            <li data-name="addlayer"><a href="module-ol_Map-Map.html#addLayer">addLayer</a>
            <li data-name="addoverlay"><a href="module-ol_Map-Map.html#addOverlay">addOverlay</a>
            <li data-name="changed"><a href="module-ol_Map-Map.html#changed">changed</a>
            <li data-name="dispatchevent"><a href="module-ol_Map-Map.html#dispatchEvent">dispatchEvent</a>
            <li data-name="foreachfeatureatpixel"><a href="module-ol_Map-Map.html#forEachFeatureAtPixel">forEachFeatureAtPixel</a>
            <li data-name="foreachlayeratpixel"><a href="module-ol_Map-Map.html#forEachLayerAtPixel">forEachLayerAtPixel</a>
            <li data-name="get"><a href="module-ol_Map-Map.html#get">get</a>
            <li data-name="getalllayers"><a href="module-ol_Map-Map.html#getAllLayers">getAllLayers</a>
            <li data-name="getcontrols"><a href="module-ol_Map-Map.html#getControls">getControls</a>
            <li data-name="getcoordinatefrompixel"><a href="module-ol_Map-Map.html#getCoordinateFromPixel">getCoordinateFromPixel</a>
            <li data-name="geteventcoordinate"><a href="module-ol_Map-Map.html#getEventCoordinate">getEventCoordinate</a>
            <li data-name="geteventpixel"><a href="module-ol_Map-Map.html#getEventPixel">getEventPixel</a>
            <li data-name="getfeaturesatpixel"><a href="module-ol_Map-Map.html#getFeaturesAtPixel">getFeaturesAtPixel</a>
            <li data-name="getinteractions"><a href="module-ol_Map-Map.html#getInteractions">getInteractions</a>
            <li data-name="getkeys"><a href="module-ol_Map-Map.html#getKeys">getKeys</a>
            <li data-name="getlayergroup"><a href="module-ol_Map-Map.html#getLayerGroup">getLayerGroup</a>
            <li data-name="getlayers"><a href="module-ol_Map-Map.html#getLayers">getLayers</a>
            <li data-name="getoverlaybyid"><a href="module-ol_Map-Map.html#getOverlayById">getOverlayById</a>
            <li data-name="getoverlays"><a href="module-ol_Map-Map.html#getOverlays">getOverlays</a>
            <li data-name="getpixelfromcoordinate"><a href="module-ol_Map-Map.html#getPixelFromCoordinate">getPixelFromCoordinate</a>
            <li data-name="getproperties"><a href="module-ol_Map-Map.html#getProperties">getProperties</a>
            <li data-name="getrevision"><a href="module-ol_Map-Map.html#getRevision">getRevision</a>
            <li data-name="getsize"><a href="module-ol_Map-Map.html#getSize">getSize</a>
            <li data-name="gettarget"><a href="module-ol_Map-Map.html#getTarget">getTarget</a>
            <li data-name="gettargetelement"><a href="module-ol_Map-Map.html#getTargetElement">getTargetElement</a>
            <li data-name="getview"><a href="module-ol_Map-Map.html#getView">getView</a>
            <li data-name="getviewport"><a href="module-ol_Map-Map.html#getViewport">getViewport</a>
            <li data-name="hasfeatureatpixel"><a href="module-ol_Map-Map.html#hasFeatureAtPixel">hasFeatureAtPixel</a>
            <li data-name="on"><a href="module-ol_Map-Map.html#on">on</a>
            <li data-name="once"><a href="module-ol_Map-Map.html#once">once</a>
            <li data-name="removecontrol"><a href="module-ol_Map-Map.html#removeControl">removeControl</a>
            <li data-name="removeinteraction"><a href="module-ol_Map-Map.html#removeInteraction">removeInteraction</a>
            <li data-name="removelayer"><a href="module-ol_Map-Map.html#removeLayer">removeLayer</a>
            <li data-name="removeoverlay"><a href="module-ol_Map-Map.html#removeOverlay">removeOverlay</a>
            <li data-name="render"><a href="module-ol_Map-Map.html#render">render</a>
            <li data-name="rendersync"><a href="module-ol_Map-Map.html#renderSync">renderSync</a>
            <li data-name="set"><a href="module-ol_Map-Map.html#set">set</a>
            <li data-name="setlayergroup"><a href="module-ol_Map-Map.html#setLayerGroup">setLayerGroup</a>
            <li data-name="setlayers"><a href="module-ol_Map-Map.html#setLayers">setLayers</a>
            <li data-name="setproperties"><a href="module-ol_Map-Map.html#setProperties">setProperties</a>
            <li data-name="setsize"><a href="module-ol_Map-Map.html#setSize">setSize</a>
            <li data-name="settarget"><a href="module-ol_Map-Map.html#setTarget">setTarget</a>
            <li data-name="setview"><a href="module-ol_Map-Map.html#setView">setView</a>
            <li data-name="un"><a href="module-ol_Map-Map.html#un">un</a>
            <li data-name="unset"><a href="module-ol_Map-Map.html#unset">unset</a>
            <li data-name="updatesize"><a href="module-ol_Map-Map.html#updateSize">updateSize</a>
        </ul>
    </div>
    <div class="member-list" data-type="fires">
        <span class="subtitle">Fires</span>
        <ul>
            <li data-name="change"><a href="module-ol_events_Event-BaseEvent.html#event:change">change</a>
            <li data-name="change:layergroup">change:layerGroup
            <li data-name="change:size">change:size
            <li data-name="change:target">change:target
            <li data-name="change:view">change:view
            <li data-name="click"><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:click">click</a>
            <li data-name="dblclick"><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:dblclick">dblclick</a>
            <li data-name="error"><a href="module-ol_events_Event-BaseEvent.html#event:error">error</a>
            <li data-name="moveend"><a href="module-ol_MapEvent-MapEvent.html#event:moveend">moveend</a>
            <li data-name="movestart"><a href="module-ol_MapEvent-MapEvent.html#event:movestart">movestart</a>
            <li data-name="pointerdrag"><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:pointerdrag">pointerdrag</a>
            <li data-name="pointermove"><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:pointermove">pointermove</a>
            <li data-name="postcompose"><a href="module-ol_render_Event-RenderEvent.html#event:postcompose">postcompose</a>
            <li data-name="postrender"><a href="module-ol_MapEvent-MapEvent.html#event:postrender">postrender</a>
            <li data-name="precompose"><a href="module-ol_render_Event-RenderEvent.html#event:precompose">precompose</a>
            <li data-name="propertychange"><a href="module-ol_Object.ObjectEvent.html#event:propertychange">propertychange</a>
            <li data-name="rendercomplete"><a href="module-ol_render_Event-RenderEvent.html#event:rendercomplete">rendercomplete</a>
            <li data-name="singleclick"><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:singleclick">singleclick</a>
        </ul>
    </div>
              <li class="loading">Loading …
            </ul>
          </div>
        </div>

        <div class="main col-md-8 col-lg-9">
            <h1 class="page-title" data-filename="module-ol_Map-Map.html">Class: Map</h1>
            <div id="latest-check" class="alert alert-warning alert-dismissible" role="alert" style="display:none">
              <button id="latest-dismiss" type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
              This documentation is for OpenLayers v<span id="package-version">6.13.0</span>. The <a id="latest-link" href="#" class="alert-link">latest</a> is v<span id="latest-version"></span>.
            </div>
            



<section class="content">

<header>
    <h2 class="my-3">
        <span class="ancestors"><a href="module-ol_Map.html">ol/Map</a>~</span>Map
    </h2>
    <br>
    
      
      
        <pre class="prettyprint source"><code>import Map from '<a href="module-ol_Map.html">ol/Map</a>';</code></pre>
      
    
    <div class="row p-3 ">
      <div id="ad" class="col-lg-5 order-2 align-self-center border rounded bg-light ">
        <script async type="text/javascript" src="https://cdn.carbonads.com/carbon.js?serve=CE7DV53U&placement=openlayersorg" id="_carbonads_js"></script>
      </div>
    
      <div class="class-description col-lg-7 align-self-center pl-0"><p>The map is the core component of OpenLayers. For a map to render, a view,
one or more layers, and a target container are needed:</p>
<pre class="prettyprint source"><code>import Map from 'ol/Map';
import View from 'ol/View';
import TileLayer from 'ol/layer/Tile';
import OSM from 'ol/source/OSM';

var map = new Map({
  view: new View({
    center: [0, 0],
    zoom: 1
  }),
  layers: [
    new TileLayer({
      source: new OSM()
    })
  ],
  target: 'map'
});</code></pre><p>The above snippet creates a map using a <a href="module-ol_layer_Tile-TileLayer.html"><code>module:ol/layer/Tile~TileLayer</code></a> to
display <a href="module-ol_source_OSM-OSM.html"><code>module:ol/source/OSM~OSM</code></a> OSM data and render it to a DOM
element with the id <code>map</code>.</p>
<p>The constructor places a viewport container (with CSS class name
<code>ol-viewport</code>) in the target element (see <code>getViewport()</code>), and then two
further elements within the viewport: one with CSS class name
<code>ol-overlaycontainer-stopevent</code> for controls and some overlays, and one with
CSS class name <code>ol-overlaycontainer</code> for other overlays (see the <code>stopEvent</code>
option of <a href="module-ol_Overlay-Overlay.html"><code>module:ol/Overlay~Overlay</code></a> for the difference). The map
itself is placed in a further element within the viewport.</p>
<p>Layers are stored as a <a href="module-ol_Collection-Collection.html"><code>module:ol/Collection~Collection</code></a> in
layerGroups. A top-level group is provided by the library. This is what is
accessed by <code>getLayerGroup</code> and <code>setLayerGroup</code>. Layers entered in the
options are added to this group, and <code>addLayer</code> and <code>removeLayer</code> change the
layer collection in the group. <code>getLayers</code> is a convenience function for
<code>getLayerGroup().getLayers()</code>. Note that <a href="module-ol_layer_Group-LayerGroup.html"><code>module:ol/layer/Group~LayerGroup</code></a>
is a subclass of <a href="module-ol_layer_Base-BaseLayer.html"><code>module:ol/layer/Base~BaseLayer</code></a>, so layers entered in the
options or added with <code>addLayer</code> can be groups, which can contain further
groups, and so on.</p></div>
    
    </div>
</header>

<article>
    <div class="container-overview">
    

    
        <dl>
            
<dt class="">
    
    <div class="nameContainer">
        <div class="anchor" id="Map">
        </div>
        <h4 class="name">
            new Map<span class="signature">(options)</span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Map.js">Map.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Map.js#L57">line 57</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>options</code></td>
            
            
            

            <td colspan=2 class="description last">
                
                <p>Map options.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>controls</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a>></span>
|

<span class="param-type">Array.&lt;<a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a>></span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Controls initially added to the map. If not specified,
<a href="module-ol_control.html#.defaults"><code>module:ol/control.defaults</code></a> is used.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>pixelRatio</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to window.devicePixelRatio)
                
            
            </td>

            

            <td  class="description last">
                
                <p>The ratio between
physical pixels and device-independent pixels (dips) on the device.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>interactions</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a>></span>
|

<span class="param-type">Array.&lt;<a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a>></span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Interactions that are initially added to the map. If not specified,
<a href="module-ol_interaction.html#.defaults"><code>module:ol/interaction.defaults</code></a> is used.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>keyboardEventTarget</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">HTMLElement</span>
|

<span class="param-type">Document</span>
|

<span class="param-type">string</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>The element to
listen to keyboard events on. This determines when the <code>KeyboardPan</code> and
<code>KeyboardZoom</code> interactions trigger. For example, if this option is set to
<code>document</code> the keyboard interactions will always trigger. If this option is
not specified, the element the library listens to keyboard events on is the
map target (i.e. the user-provided div for the map). If this is not
<code>document</code>, the target element needs to be focused for key events to be
emitted, requiring that the target element has a <code>tabindex</code> attribute.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>layers</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>></span>
|

<span class="param-type"><a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>></span>
|

<span class="param-type"><a href="module-ol_layer_Group-LayerGroup.html">module:ol/layer/Group~LayerGroup</a></span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Layers. If this is not defined, a map with no layers will be rendered. Note
that layers are rendered in the order supplied, so if you want, for example,
a vector layer to appear on top of a tile layer, it must come after the tile
layer.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>maxTilesLoading</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 16)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Maximum number tiles to load
simultaneously.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>moveTolerance</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 1)
                
            
            </td>

            

            <td  class="description last">
                
                <p>The minimum distance in pixels the
cursor must move to be detected as a map move event instead of a click.
Increasing this value can make it easier to click on the map.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>overlays</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a>></span>
|

<span class="param-type">Array.&lt;<a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a>></span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Overlays initially added to the map. By default, no overlays are added.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>target</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">HTMLElement</span>
|

<span class="param-type">string</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>The container for the map, either the
element itself or the <code>id</code> of the element. If not specified at construction
time, <a href="module-ol_Map-Map.html#setTarget"><code>module:ol/Map~Map#setTarget</code></a> must be called for the map to be
rendered. If passed by element, the container can be in a secondary document.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>view</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_View-View.html">module:ol/View~View</a></span>
|

<span class="param-type">Promise.&lt;<a href="module-ol_View.html#~ViewOptions">module:ol/View~ViewOptions</a>></span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>The map's view.  No layer sources will be
fetched unless this is specified at construction time or through
<a href="module-ol_Map-Map.html#setView"><code>module:ol/Map~Map#setView</code></a>.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    
    <h5>Fires:</h5>
    <ul>
        <li class="">
            <code><a href="module-ol_events_Event-BaseEvent.html#event:change">change</a></code>
            
              (<a href="module-ol_events_Event-BaseEvent.html">module:ol/events/Event~BaseEvent</a>)
            
            

             -
            Generic change event. Triggered when the revision counter is increased.
            
        </li>
    
        <li class="">
            <code>change:layerGroup</code>
            
              (<a href="module-ol_Object.ObjectEvent.html">module:ol/Object.ObjectEvent</a>)
            
            

            
        </li>
    
        <li class="">
            <code>change:size</code>
            
              (<a href="module-ol_Object.ObjectEvent.html">module:ol/Object.ObjectEvent</a>)
            
            

            
        </li>
    
        <li class="">
            <code>change:target</code>
            
              (<a href="module-ol_Object.ObjectEvent.html">module:ol/Object.ObjectEvent</a>)
            
            

            
        </li>
    
        <li class="">
            <code>change:view</code>
            
              (<a href="module-ol_Object.ObjectEvent.html">module:ol/Object.ObjectEvent</a>)
            
            

            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:click">click</a></code>
            
              (<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">module:ol/MapBrowserEvent~MapBrowserEvent</a>)
            
            

             -
            A click with no dragging. A double click will fire two of this.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:dblclick">dblclick</a></code>
            
              (<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">module:ol/MapBrowserEvent~MapBrowserEvent</a>)
            
            

             -
            A true double click, with no dragging.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_events_Event-BaseEvent.html#event:error">error</a></code>
            
              (<a href="module-ol_events_Event-BaseEvent.html">module:ol/events/Event~BaseEvent</a>)
            
            

             -
            Generic error event. Triggered when an error occurs.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapEvent-MapEvent.html#event:moveend">moveend</a></code>
            
              (<a href="module-ol_MapEvent-MapEvent.html">module:ol/MapEvent~MapEvent</a>)
            
            

             -
            Triggered after the map is moved.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapEvent-MapEvent.html#event:movestart">movestart</a></code>
            
              (<a href="module-ol_MapEvent-MapEvent.html">module:ol/MapEvent~MapEvent</a>)
            
            

             -
            Triggered when the map starts moving.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:pointerdrag">pointerdrag</a></code>
            
              (<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">module:ol/MapBrowserEvent~MapBrowserEvent</a>)
            
            

             -
            Triggered when a pointer is dragged.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:pointermove">pointermove</a></code>
            
              (<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">module:ol/MapBrowserEvent~MapBrowserEvent</a>)
            
            

             -
            Triggered when a pointer is moved. Note that on touch devices this is
triggered when the map is panned, so is not the same as mousemove.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_render_Event-RenderEvent.html#event:postcompose">postcompose</a></code>
            
              (<a href="module-ol_render_Event-RenderEvent.html">module:ol/render/Event~RenderEvent</a>)
            
            

             -
            Triggered after layers are composed.  When dispatched by the map, the event object will not have
a context set.  When dispatched by a layer, the event object will have a context set.  Only
WebGL layers currently dispatch this event.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapEvent-MapEvent.html#event:postrender">postrender</a></code>
            
              (<a href="module-ol_MapEvent-MapEvent.html">module:ol/MapEvent~MapEvent</a>)
            
            

             -
            Triggered after a map frame is rendered.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_render_Event-RenderEvent.html#event:precompose">precompose</a></code>
            
              (<a href="module-ol_render_Event-RenderEvent.html">module:ol/render/Event~RenderEvent</a>)
            
            

             -
            Triggered before layers are composed.  When dispatched by the map, the event object will not have
a context set.  When dispatched by a layer, the event object will have a context set.  Only
WebGL layers currently dispatch this event.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_Object.ObjectEvent.html#event:propertychange">propertychange</a></code>
            
              (<a href="module-ol_Object.ObjectEvent.html">module:ol/Object.ObjectEvent</a>)
            
            

             -
            Triggered when a property is changed.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_render_Event-RenderEvent.html#event:rendercomplete">rendercomplete</a></code>
            
              (<a href="module-ol_render_Event-RenderEvent.html">module:ol/render/Event~RenderEvent</a>)
            
            

             -
            Triggered when rendering is complete, i.e. all sources and tiles have
finished loading for the current viewport, and all tiles are faded in.
The event object will not have a context set.
            
        </li>
    
        <li class="">
            <code><a href="module-ol_MapBrowserEvent-MapBrowserEvent.html#event:singleclick">singleclick</a></code>
            
              (<a href="module-ol_MapBrowserEvent-MapBrowserEvent.html">module:ol/MapBrowserEvent~MapBrowserEvent</a>)
            
            

             -
            A true single click with no dragging and no double click. Note that this
event is delayed by 250 ms to ensure that it is not a double click.
            
        </li>
    </ul>
    

    

    

    

    

    
</dd>

        </dl>
    
    </div>

    

    
        <h3 class="subsection-title">Extends</h3>

        <ul>
            <li><a href="module-ol_PluggableMap-PluggableMap.html">module:ol/PluggableMap~PluggableMap</a></li>
        </ul>
    

    

    

    

    

    
        <h3 class="subsection-title">Observable Properties</h3>
        <dl>

<table class="props">
    <thead>
  <tr>
    <th>Name</th>
    <th>Type</th>
    <th>Settable</th>
    <th><a href="module-ol_Object.ObjectEvent.html">ol/Object.ObjectEvent</a> type</th>
    <th class="last">Description</th>
  </tr>
  </thead>

  <tbody>
  

    <tr class="">
      <td class="name"><code>layerGroup</code></td>
      <td class="type">
      
      
<span class="param-type"><a href="module-ol_layer_Group-LayerGroup.html">module:ol/layer/Group~LayerGroup</a></span>


      
      </td>
      <td class="setter">yes</td>
      <td class="event"><code>change:layergroup</code></td>
      <td class="description last"><p>A layer group containing the layers in this map.</p></td>
    </tr>
    

    <tr class="">
      <td class="name"><code>size</code></td>
      <td class="type">
      
      
<span class="param-type"><a href="module-ol_size.html#~Size">module:ol/size~Size</a></span>
|

<span class="param-type">undefined</span>


      
      </td>
      <td class="setter">yes</td>
      <td class="event"><code>change:size</code></td>
      <td class="description last"><p>The size in pixels of the map in the DOM.</p></td>
    </tr>
    

    <tr class="">
      <td class="name"><code>target</code></td>
      <td class="type">
      
      
<span class="param-type">HTMLElement</span>
|

<span class="param-type">string</span>
|

<span class="param-type">undefined</span>


      
      </td>
      <td class="setter">yes</td>
      <td class="event"><code>change:target</code></td>
      <td class="description last"><p>The Element or id of the Element that the
    map is rendered in.</p></td>
    </tr>
    

    <tr class="">
      <td class="name"><code>view</code></td>
      <td class="type">
      
      
<span class="param-type"><a href="module-ol_View-View.html">module:ol/View~View</a></span>


      
      </td>
      <td class="setter">yes</td>
      <td class="event"><code>change:view</code></td>
      <td class="description last"><p>The view that controls this map.</p></td>
    </tr>
    
  </tbody>
</table>
</dl>

    

    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="addControl">
        </div>
        <h4 class="name">
            addControl<span class="signature">(control)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#addControl">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L538">line 538</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Add the given control to the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>control</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Control.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="addInteraction">
        </div>
        <h4 class="name">
            addInteraction<span class="signature">(interaction)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#addInteraction">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L551">line 551</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Add the given interaction to the map. If you want to add an interaction
at another point of the collection use <code>getInteraction()</code> and the methods
available on <a href="module-ol_Collection-Collection.html"><code>module:ol/Collection~Collection</code></a>. This can be used to
stop the event propagation from the handleEvent function. The interactions
get to handle the events in the reverse order of this collection.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>interaction</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Interaction to add.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="addLayer">
        </div>
        <h4 class="name">
            addLayer<span class="signature">(layer)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#addLayer">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L562">line 562</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Adds the given layer to the top of this map. If you want to add a layer
elsewhere in the stack, use <code>getLayers()</code> and the methods available on
<a href="module-ol_Collection-Collection.html"><code>module:ol/Collection~Collection</code></a>.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layer</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="addOverlay">
        </div>
        <h4 class="name">
            addOverlay<span class="signature">(overlay)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#addOverlay">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L580">line 580</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Add the given overlay to the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>overlay</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Overlay.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="changed">
        </div>
        <h4 class="name">
            changed<span class="signature">()</span>
            
                <span class="inherited"><a href="module-ol_Observable-Observable.html#changed">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js">Observable.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js#L68">line 68</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Increases the revision counter and dispatches a 'change' event.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="dispatchEvent">
        </div>
        <h4 class="name">
            dispatchEvent<span class="signature">(event)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{boolean|undefined}</span>
            
                <span class="inherited"><a href="module-ol_events_Target-Target.html#dispatchEvent">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/events/Target.js">events/Target.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/events/Target.js#L85">line 85</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Dispatches an event and calls all listeners listening for events
of this type. The event parameter can either be a string or an
Object with a <code>type</code> property.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>event</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_events_Event-BaseEvent.html">module:ol/events/Event~BaseEvent</a></span>
|

<span class="param-type">string</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Event object.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
<code>false</code> if anyone called preventDefault on the
    event object or if any of the listeners returned false.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="forEachFeatureAtPixel">
        </div>
        <h4 class="name">
            forEachFeatureAtPixel<span class="signature">(pixel, callback, <span class="optional">opt_options</span>)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{T|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#forEachFeatureAtPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L624">line 624</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Detect features that intersect a pixel on the viewport, and execute a
callback with each intersecting feature. Layers included in the detection can
be configured through the <code>layerFilter</code> option in <code>opt_options</code>.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>pixel</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Pixel.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>callback</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Feature callback. The callback will be
    called with two arguments. The first argument is one
    <a href="module-ol_Feature-Feature.html"><code>feature</code></a> or
    <a href="module-ol_render_Feature-RenderFeature.html"><code>render feature</code></a> at the pixel, the second is
    the <a href="module-ol_layer_Layer-Layer.html"><code>layer</code></a> of the feature and will be null for
    unmanaged layers. To stop detection, callback functions can return a
    truthy value.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>options</code></td>
            
            
            

            <td colspan=2 class="description last">
                
                <p>Optional options.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layerFilter</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">undefined</span>
|

<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer filter
function. The filter function will receive one argument, the
<a href="module-ol_layer_Layer-Layer.html"><code>layer-candidate</code></a> and it should return a boolean value.
Only layers which are visible and for which this function returns <code>true</code>
will be tested for features. By default, all visible layers will be tested.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>hitTolerance</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 0)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Hit-detection tolerance in css pixels. Pixels
inside the radius around the given position will be checked for features.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>checkWrapped</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


                
                    (defaults to true)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Check-Wrapped Will check for for wrapped geometries inside the range of
  +/- 1 world width. Works only if a projection is used that can be wrapped.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Callback result, i.e. the return value of last
callback execution, or the first truthy callback return value.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="forEachLayerAtPixel">
        </div>
        <h4 class="name">
            forEachLayerAtPixel<span class="signature">(pixel, callback, <span class="optional">opt_options</span>)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{T|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#forEachLayerAtPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L715">line 715</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Please the <code>layer.getData()</code> method for <a href="module-ol_layer_Tile-TileLayer.html#getData"><code>tile layers</code></a> or
<a href="module-ol_layer_Image-ImageLayer.html#getData"><code>image layers</code></a> instead of using this method.</p>
<p>Detect layers that have a color value at a pixel on the viewport, and
execute a callback with each matching layer. Layers included in the
detection can be configured through <code>opt_layerFilter</code>.</p>
<p>Note: In maps with more than one layer, this method will typically return pixel data
representing the composed image of all layers visible at the given pixel – because layers
will generally share the same rendering context.  To force layers to render separately, and
to get pixel data representing only one layer at a time, you can assign each layer a unique
<code>className</code> in its constructor.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>pixel</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Pixel.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>callback</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer callback. This callback will receive two arguments: first is the
    <a href="module-ol_layer_Layer-Layer.html"><code>layer</code></a>, second argument is an array representing
    [R, G, B, A] pixel values (0 - 255) and will be <code>null</code> for layer types
    that do not currently support this argument. To stop detection, callback
    functions can return a truthy value.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>options</code></td>
            
            
            

            <td colspan=2 class="description last">
                
                <p>Configuration options.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layerFilter</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">undefined</span>
|

<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer filter
function. The filter function will receive one argument, the
<a href="module-ol_layer_Layer-Layer.html"><code>layer-candidate</code></a> and it should return a boolean value.
Only layers which are visible and for which this function returns <code>true</code>
will be tested for features. By default, all visible layers will be tested.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>hitTolerance</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 0)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Hit-detection tolerance in css pixels. Pixels
inside the radius around the given position will be checked for features.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>checkWrapped</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


                
                    (defaults to true)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Check-Wrapped Will check for for wrapped geometries inside the range of
  +/- 1 world width. Works only if a projection is used that can be wrapped.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
        <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Callback result, i.e. the return value of last
callback execution, or the first truthy callback return value.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="get">
        </div>
        <h4 class="name">
            get<span class="signature">(key)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{*}</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#get">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L135">line 135</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Gets a value.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>key</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Key name.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Value.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getAllLayers">
        </div>
        <h4 class="name">
            getAllLayers<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{Array.&lt;<a href="module-ol_layer_Layer-Layer.html">module:ol/layer/Layer~Layer</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getAllLayers">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L672">line 672</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get all layers from all layer groups.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Layers.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getControls">
        </div>
        <h4 class="name">
            getControls<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getControls">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L871">line 871</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the map controls. Modifying this collection changes the controls
associated with the map.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Controls.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getCoordinateFromPixel">
        </div>
        <h4 class="name">
            getCoordinateFromPixel<span class="signature">(pixel)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_coordinate.html#~Coordinate">module:ol/coordinate~Coordinate</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getCoordinateFromPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L840">line 840</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the coordinate for a given pixel.  This returns a coordinate in the
user projection.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>pixel</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Pixel position in the map viewport.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The coordinate for the pixel position.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getEventCoordinate">
        </div>
        <h4 class="name">
            getEventCoordinate<span class="signature">(event)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_coordinate.html#~Coordinate">module:ol/coordinate~Coordinate</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getEventCoordinate">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L767">line 767</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Returns the coordinate in user projection for a browser event.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>event</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">MouseEvent</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Event.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Coordinate.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getEventPixel">
        </div>
        <h4 class="name">
            getEventPixel<span class="signature">(event)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getEventPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L786">line 786</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Returns the map pixel position for a browser event relative to the viewport.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>event</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">UIEvent</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Event.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Pixel.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getFeaturesAtPixel">
        </div>
        <h4 class="name">
            getFeaturesAtPixel<span class="signature">(pixel, <span class="optional">opt_options</span>)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{Array.&lt;<a href="module-ol_Feature.html#~FeatureLike">module:ol/Feature~FeatureLike</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getFeaturesAtPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L655">line 655</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get all features that intersect a pixel on the viewport.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>pixel</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Pixel.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>options</code></td>
            
            
            

            <td colspan=2 class="description last">
                
                <p>Optional options.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layerFilter</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">undefined</span>
|

<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer filter
function. The filter function will receive one argument, the
<a href="module-ol_layer_Layer-Layer.html"><code>layer-candidate</code></a> and it should return a boolean value.
Only layers which are visible and for which this function returns <code>true</code>
will be tested for features. By default, all visible layers will be tested.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>hitTolerance</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 0)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Hit-detection tolerance in css pixels. Pixels
inside the radius around the given position will be checked for features.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>checkWrapped</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


                
                    (defaults to true)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Check-Wrapped Will check for for wrapped geometries inside the range of
  +/- 1 world width. Works only if a projection is used that can be wrapped.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The detected features or
an empty array if none were found.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getInteractions">
        </div>
        <h4 class="name">
            getInteractions<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getInteractions">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L906">line 906</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the map interactions. Modifying this collection changes the interactions
associated with the map.</p>
<p>Interactions are used for e.g. pan, zoom and rotate.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Interactions.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getKeys">
        </div>
        <h4 class="name">
            getKeys<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#getKeys">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L148">line 148</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get a list of object property names.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
List of property names.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getLayerGroup">
        </div>
        <h4 class="name">
            getLayerGroup<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_layer_Group-LayerGroup.html">module:ol/layer/Group~LayerGroup</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getLayerGroup">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L916">line 916</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the layergroup associated with this map.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
A layer group containing the layers in this map.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getLayers">
        </div>
        <h4 class="name">
            getLayers<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getLayers">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L942">line 942</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the collection of layers associated with this map.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Layers.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getOverlayById">
        </div>
        <h4 class="name">
            getOverlayById<span class="signature">(id)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getOverlayById">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L893">line 893</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get an overlay by its identifier (the value returned by overlay.getId()).
Note that the index treats string and numeric identifiers as the same. So
<code>map.getOverlayById(2)</code> will return an overlay with id <code>'2'</code> or <code>2</code>.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>id</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Overlay identifier.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Overlay.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getOverlays">
        </div>
        <h4 class="name">
            getOverlays<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a>>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getOverlays">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L881">line 881</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the map overlays. Modifying this collection changes the overlays
associated with the map.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Overlays.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getPixelFromCoordinate">
        </div>
        <h4 class="name">
            getPixelFromCoordinate<span class="signature">(coordinate)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getPixelFromCoordinate">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L974">line 974</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the pixel for a coordinate.  This takes a coordinate in the user
projection and returns the corresponding pixel.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>coordinate</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_coordinate.html#~Coordinate">module:ol/coordinate~Coordinate</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>A map coordinate.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
A pixel position in the map viewport.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getProperties">
        </div>
        <h4 class="name">
            getProperties<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{Object.&lt;string, *>}</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#getProperties">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L157">line 157</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get an object of all property names and values.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Object.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getRevision">
        </div>
        <h4 class="name">
            getRevision<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{number}</span>
            
                <span class="inherited"><a href="module-ol_Observable-Observable.html#getRevision">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js">Observable.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js#L79">line 79</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the version number for this object.  Each time the object is modified,
its version number will be incremented.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Revision.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getSize">
        </div>
        <h4 class="name">
            getSize<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_size.html#~Size">module:ol/size~Size</a>|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getSize">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1014">line 1014</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the size of this map.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The size in pixels of the map in the DOM.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getTarget">
        </div>
        <h4 class="name">
            getTarget<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{HTMLElement|string|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getTarget">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L809">line 809</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the target in which this map is rendered.
Note that this returns what is entered as an option or in setTarget:
if that was an element, it returns an element; if a string, it returns that.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The Element or id of the Element that the
    map is rendered in.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getTargetElement">
        </div>
        <h4 class="name">
            getTargetElement<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{HTMLElement}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getTargetElement">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L822">line 822</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the DOM element into which this map is rendered. In contrast to
<code>getTarget</code> this method always return an <code>Element</code>, or <code>null</code> if the
map has no target.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The element that the map is rendered in.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getView">
        </div>
        <h4 class="name">
            getView<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_View-View.html">module:ol/View~View</a>}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getView">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1027">line 1027</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the view associated with this map. A view manages properties such as
center and resolution.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The view that controls this map.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="getViewport">
        </div>
        <h4 class="name">
            getViewport<span class="signature">()</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{HTMLElement}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#getViewport">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1036">line 1036</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Get the element that serves as the map viewport.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Viewport.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="hasFeatureAtPixel">
        </div>
        <h4 class="name">
            hasFeatureAtPixel<span class="signature">(pixel, <span class="optional">opt_options</span>)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{boolean}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#hasFeatureAtPixel">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L740">line 740</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Detect if features intersect a pixel on the viewport. Layers included in the
detection can be configured through <code>opt_layerFilter</code>.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>pixel</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_pixel.html#~Pixel">module:ol/pixel~Pixel</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Pixel.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>options</code></td>
            
            
            

            <td colspan=2 class="description last">
                
                <p>Optional options.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layerFilter</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">undefined</span>
|

<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer filter
function. The filter function will receive one argument, the
<a href="module-ol_layer_Layer-Layer.html"><code>layer-candidate</code></a> and it should return a boolean value.
Only layers which are visible and for which this function returns <code>true</code>
will be tested for features. By default, all visible layers will be tested.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>hitTolerance</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


                
                    (defaults to 0)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Hit-detection tolerance in css pixels. Pixels
inside the radius around the given position will be checked for features.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>checkWrapped</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


                
                    (defaults to true)
                
            
            </td>

            

            <td  class="description last">
                
                <p>Check-Wrapped Will check for for wrapped geometries inside the range of
  +/- 1 world width. Works only if a projection is used that can be wrapped.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Is there a feature at the given pixel?
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="on">
        </div>
        <h4 class="name">
            on<span class="signature">(type, listener)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_events.html#~EventsKey">module:ol/events~EventsKey</a>|Array.&lt;<a href="module-ol_events.html#~EventsKey">module:ol/events~EventsKey</a>>}</span>
            
                <span class="inherited"><a href="module-ol_Observable-Observable.html#on">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js">Observable.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js#L153">line 153</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Listen for a certain type of event.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>type</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array.&lt;string></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The event type or array of event types.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>listener</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The listener function.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Unique key for the listener. If
    called with an array of event types as the first argument, the return
    will be an array of keys.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="once">
        </div>
        <h4 class="name">
            once<span class="signature">(type, listener)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_events.html#~EventsKey">module:ol/events~EventsKey</a>|Array.&lt;<a href="module-ol_events.html#~EventsKey">module:ol/events~EventsKey</a>>}</span>
            
                <span class="inherited"><a href="module-ol_Observable-Observable.html#once">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js">Observable.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js#L165">line 165</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Listen once for a certain type of event.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>type</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array.&lt;string></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The event type or array of event types.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>listener</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The listener function.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
Unique key for the listener. If
    called with an array of event types as the first argument, the return
    will be an array of keys.
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="removeControl">
        </div>
        <h4 class="name">
            removeControl<span class="signature">(control)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a>|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#removeControl">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1426">line 1426</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Remove the given control from the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>control</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_control_Control-Control.html">module:ol/control/Control~Control</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Control.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The removed control (or undefined
    if the control was not found).
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="removeInteraction">
        </div>
        <h4 class="name">
            removeInteraction<span class="signature">(interaction)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a>|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#removeInteraction">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1437">line 1437</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Remove the given interaction from the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>interaction</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_interaction_Interaction-Interaction.html">module:ol/interaction/Interaction~Interaction</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Interaction to remove.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The removed interaction (or
    undefined if the interaction was not found).
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="removeLayer">
        </div>
        <h4 class="name">
            removeLayer<span class="signature">(layer)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#removeLayer">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1448">line 1448</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Removes the given layer from the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layer</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Layer.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The removed layer (or undefined if the
    layer was not found).
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="removeOverlay">
        </div>
        <h4 class="name">
            removeOverlay<span class="signature">(overlay)</span><span class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a>|undefined}</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#removeOverlay">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1468">line 1468</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Remove the given overlay from the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>overlay</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_Overlay-Overlay.html">module:ol/Overlay~Overlay</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Overlay.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    
    
    


<h5>Returns:</h5>
The removed overlay (or undefined
    if the overlay was not found).
<br />

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="render">
        </div>
        <h4 class="name">
            render<span class="signature">()</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#render">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1413">line 1413</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Request a map rendering (at the next animation frame).</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="renderSync">
        </div>
        <h4 class="name">
            renderSync<span class="signature">()</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#renderSync">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1389">line 1389</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Requests an immediate render in a synchronous manner.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="set">
        </div>
        <h4 class="name">
            set<span class="signature">(key, value, <span class="optional">opt_silent</span>)</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#set">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L207">line 207</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Sets a value.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>key</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Key name.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>value</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">*</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Value.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>silent</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Update without triggering an event.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setLayerGroup">
        </div>
        <h4 class="name">
            setLayerGroup<span class="signature">(layerGroup)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#setLayerGroup">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1587">line 1587</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Sets the layergroup of this map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layerGroup</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_layer_Group-LayerGroup.html">module:ol/layer/Group~LayerGroup</a></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>A layer group containing the layers in this map.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setLayers">
        </div>
        <h4 class="name">
            setLayers<span class="signature">(layers)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#setLayers">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L925">line 925</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Clear any existing layers and add layers to the map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>layers</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>></span>
|

<span class="param-type"><a href="module-ol_Collection-Collection.html">module:ol/Collection~Collection</a>.&lt;<a href="module-ol_layer_Base-BaseLayer.html">module:ol/layer/Base~BaseLayer</a>></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The layers to be added to the map.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setProperties">
        </div>
        <h4 class="name">
            setProperties<span class="signature">(values, <span class="optional">opt_silent</span>)</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#setProperties">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L227">line 227</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Sets a collection of key-value pairs.  Note that this changes any existing
properties and adds new ones (it does not remove any existing properties).</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>values</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">Object.&lt;string, *></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Values.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>silent</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Update without triggering an event.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setSize">
        </div>
        <h4 class="name">
            setSize<span class="signature">(size)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#setSize">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1601">line 1601</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Set the size of this map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>size</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_size.html#~Size">module:ol/size~Size</a></span>
|

<span class="param-type">undefined</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The size in pixels of the map in the DOM.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setTarget">
        </div>
        <h4 class="name">
            setTarget<span class="signature">(<span class="optional">target</span>)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#setTarget">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1612">line 1612</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Set the target element to render this map into.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>target</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">HTMLElement</span>
|

<span class="param-type">string</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>The Element or id of the Element
    that the map is rendered in.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="setView">
        </div>
        <h4 class="name">
            setView<span class="signature">(view)</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#setView">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1625">line 1625</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Set the view for this map.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>view</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type"><a href="module-ol_View-View.html">module:ol/View~View</a></span>
|

<span class="param-type">Promise.&lt;<a href="module-ol_View.html#~ViewOptions">module:ol/View~ViewOptions</a>></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The view that controls this map.
It is also possible to pass a promise that resolves to options for constructing a view.  This
alternative allows view properties to be resolved by sources or other components that load
view-related metadata.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="un">
        </div>
        <h4 class="name">
            un<span class="signature">(type, listener)</span>
            
                <span class="inherited"><a href="module-ol_Observable-Observable.html#un">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js">Observable.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Observable.js#L174">line 174</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Unlisten for a certain type of event.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>type</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array.&lt;string></span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The event type or array of event types.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>listener</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>The listener function.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="unset">
        </div>
        <h4 class="name">
            unset<span class="signature">(key, <span class="optional">opt_silent</span>)</span>
            
                <span class="inherited"><a href="module-ol_Object-BaseObject.html#unset">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js">Object.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/Object.js#L251">line 251</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Unsets a property.</p>
    </div>
    

    

    

    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr class="">
            
                <td class="name"><code>key</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


                
            
            </td>

            

            <td  class="description last">
                
                <p>Key name.</p></td>
        </tr>
	
	
	
        <tr class="">
            
                <td class="name"><code>silent</code></td>
            
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>

 | undefined
                
            
            </td>

            

            <td  class="description last">
                
                <p>Unset without triggering an event.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        
            
            
<dt class="">
    
    <div class="nameContainer inherited">
        <div class="anchor" id="updateSize">
        </div>
        <h4 class="name">
            updateSize<span class="signature">()</span>
            
                <span class="inherited"><a href="module-ol_PluggableMap-PluggableMap.html#updateSize">inherited</a></span>
            
            

        </h4>
        
        <div class="tag-source">
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js">PluggableMap.js</a>,
            <a href="https://github.com/openlayers/openlayers/blob/v6.13.0/src/ol/PluggableMap.js#L1643">line 1643</a>
        </div>
        
    </div>
    
    
</dt>
<dd class="">



    
    <div class="description">
        <p>Force a recalculation of the map viewport size.  This should be called when
third-party code changes the size of the map viewport.</p>
    </div>
    

    

    

    
    
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


    

    

    

    

    

    
</dd>

        </dl>
    

    

    
</article>

</section>




        </div>
      </div>
      <script>prettyPrint();</script>
      <script src="scripts/linenumber.js"></script>
      <script src="scripts/main.js"></script>
    </div>
  </body>
</html>